home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 2010 Software/Programs / PCGuia_programas.iso / Software / Utils / VLC Media Player / vlc-1.0.3-win32.exe / sdk / include / vlc / plugins / vlc_messages.h < prev    next >
Encoding:
C/C++ Source or Header  |  2009-10-30  |  6.7 KB  |  220 lines
  1. /*****************************************************************************
  2.  * messages.h: messages interface
  3.  * This library provides basic functions for threads to interact with user
  4.  * interface, such as message output.
  5.  *****************************************************************************
  6.  * Copyright (C) 1999, 2000, 2001, 2002 the VideoLAN team
  7.  * $Id$
  8.  *
  9.  * Authors: Vincent Seguin <seguin@via.ecp.fr>
  10.  *          Samuel Hocevar <sam@zoy.org>
  11.  *
  12.  * This program is free software; you can redistribute it and/or modify
  13.  * it under the terms of the GNU General Public License as published by
  14.  * the Free Software Foundation; either version 2 of the License, or
  15.  * (at your option) any later version.
  16.  *
  17.  * This program is distributed in the hope that it will be useful,
  18.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20.  * GNU General Public License for more details.
  21.  *
  22.  * You should have received a copy of the GNU General Public License
  23.  * along with this program; if not, write to the Free Software
  24.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25.  *****************************************************************************/
  26.  
  27. #ifndef VLC_MESSAGES_H_
  28. #define VLC_MESSAGES_H_
  29.  
  30. /**
  31.  * \file
  32.  * This file defines structures and functions to handle messages and statistics gathering
  33.  */
  34.  
  35. #include <stdarg.h>
  36.  
  37. /**
  38.  * \defgroup messages Messages
  39.  * This library provides basic functions for threads to interact with user
  40.  * interface, such as message output.
  41.  *
  42.  * @{
  43.  */
  44.  
  45. /**
  46.  * Store a single message sent to user.
  47.  */
  48. typedef struct
  49. {
  50.     int     i_type;                             /**< message type, see below */
  51.     uintptr_t   i_object_id;
  52.     const char *psz_object_type;
  53.     char *  psz_module;
  54.     char *  psz_msg;                            /**< the message itself */
  55.     char *  psz_header;                         /**< Additional header */
  56.  
  57.     mtime_t date;                               /**< Message date */
  58.     gc_object_t vlc_gc_data;
  59. } msg_item_t;
  60.  
  61. /* Message types */
  62. /** standard messages */
  63. #define VLC_MSG_INFO  0
  64. /** error messages */
  65. #define VLC_MSG_ERR   1
  66. /** warning messages */
  67. #define VLC_MSG_WARN  2
  68. /** debug messages */
  69. #define VLC_MSG_DBG   3
  70.  
  71. static inline msg_item_t *msg_Hold (msg_item_t *msg)
  72. {
  73.     vlc_hold (&msg->vlc_gc_data);
  74.     return msg;
  75. }
  76.  
  77. static inline void msg_Release (msg_item_t *msg)
  78. {
  79.     vlc_release (&msg->vlc_gc_data);
  80. }
  81.  
  82. /**
  83.  * Used by interface plugins which subscribe to the message bank.
  84.  */
  85. typedef struct msg_subscription_t msg_subscription_t;
  86.  
  87. /*****************************************************************************
  88.  * Prototypes
  89.  *****************************************************************************/
  90. VLC_EXPORT( void, __msg_Generic, ( vlc_object_t *, int, const char *, const char *, ... ) LIBVLC_FORMAT( 4, 5 ) );
  91. VLC_EXPORT( void, __msg_GenericVa, ( vlc_object_t *, int, const char *, const char *, va_list args ) );
  92. #define msg_GenericVa(a, b, c, d, e) __msg_GenericVa(VLC_OBJECT(a), b, c, d, e)
  93.  
  94. #define msg_Info( p_this, ... ) \
  95.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_INFO, \
  96.                      MODULE_STRING, __VA_ARGS__ )
  97. #define msg_Err( p_this, ... ) \
  98.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_ERR, \
  99.                      MODULE_STRING, __VA_ARGS__ )
  100. #define msg_Warn( p_this, ... ) \
  101.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_WARN, \
  102.                      MODULE_STRING, __VA_ARGS__ )
  103. #define msg_Dbg( p_this, ... ) \
  104.       __msg_Generic( VLC_OBJECT(p_this), VLC_MSG_DBG, \
  105.                      MODULE_STRING, __VA_ARGS__ )
  106.  
  107. typedef struct msg_cb_data_t msg_cb_data_t;
  108.  
  109. /**
  110.  * Message logging callback signature.
  111.  * Accepts one private data pointer, the message, and an overrun counter.
  112.  */
  113. typedef void (*msg_callback_t) (msg_cb_data_t *, msg_item_t *, unsigned);
  114.  
  115. VLC_EXPORT( msg_subscription_t*, msg_Subscribe, ( libvlc_int_t *, msg_callback_t, msg_cb_data_t * ) );
  116. VLC_EXPORT( void, msg_Unsubscribe, ( msg_subscription_t * ) );
  117.  
  118. /* Enable or disable a certain object debug messages */
  119. #define msg_EnableObjectPrinting(a,b) __msg_EnableObjectPrinting(VLC_OBJECT(a),b)
  120. #define msg_DisableObjectPrinting(a,b) __msg_DisableObjectPrinting(VLC_OBJECT(a),b)
  121. VLC_EXPORT( void, __msg_EnableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
  122. VLC_EXPORT( void, __msg_DisableObjectPrinting, ( vlc_object_t *, char * psz_object ) );
  123.  
  124. /**
  125.  * @}
  126.  */
  127.  
  128. /**
  129.  * \defgroup statistics Statistics
  130.  *
  131.  * @{
  132.  */
  133.  
  134. /****************************
  135.  * Generic stats stuff
  136.  ****************************/
  137. enum
  138. {
  139.     STATS_LAST,
  140.     STATS_COUNTER,
  141.     STATS_MAX,
  142.     STATS_MIN,
  143.     STATS_DERIVATIVE,
  144.     STATS_TIMER
  145. };
  146.  
  147. struct counter_sample_t
  148. {
  149.     vlc_value_t value;
  150.     mtime_t     date;
  151. };
  152.  
  153. struct counter_t
  154. {
  155.     unsigned int        i_id;
  156.     char              * psz_name;
  157.     int                 i_type;
  158.     void              * p_obj;
  159.     int                 i_compute_type;
  160.     int                 i_samples;
  161.     counter_sample_t ** pp_samples;
  162.  
  163.     mtime_t             update_interval;
  164.     mtime_t             last_update;
  165. };
  166.  
  167. enum
  168. {
  169.     STATS_INPUT_BITRATE,
  170.     STATS_READ_BYTES,
  171.     STATS_READ_PACKETS,
  172.     STATS_DEMUX_READ,
  173.     STATS_DEMUX_BITRATE,
  174.     STATS_DEMUX_CORRUPTED,
  175.     STATS_DEMUX_DISCONTINUITY,
  176.     STATS_PLAYED_ABUFFERS,
  177.     STATS_LOST_ABUFFERS,
  178.     STATS_DECODED_AUDIO,
  179.     STATS_DECODED_VIDEO,
  180.     STATS_DECODED_SUB,
  181.     STATS_CLIENT_CONNECTIONS,
  182.     STATS_ACTIVE_CONNECTIONS,
  183.     STATS_SOUT_SENT_PACKETS,
  184.     STATS_SOUT_SENT_BYTES,
  185.     STATS_SOUT_SEND_BITRATE,
  186.     STATS_DISPLAYED_PICTURES,
  187.     STATS_LOST_PICTURES,
  188.  
  189.     STATS_TIMER_PLAYLIST_BUILD,
  190.     STATS_TIMER_ML_LOAD,
  191.     STATS_TIMER_ML_DUMP,
  192.     STATS_TIMER_INTERACTION,
  193.     STATS_TIMER_PREPARSE,
  194.     STATS_TIMER_INPUT_LAUNCHING,
  195.     STATS_TIMER_MODULE_NEED,
  196.     STATS_TIMER_VIDEO_FRAME_ENCODING,
  197.     STATS_TIMER_AUDIO_FRAME_ENCODING,
  198.  
  199.     STATS_TIMER_SKINS_PLAYTREE_IMAGE,
  200. };
  201.  
  202. /*********
  203.  * Timing
  204.  ********/
  205. #define stats_TimerStart(a,b,c) __stats_TimerStart( VLC_OBJECT(a), b,c )
  206. #define stats_TimerStop(a,b) __stats_TimerStop( VLC_OBJECT(a), b )
  207. #define stats_TimerDump(a,b) __stats_TimerDump( VLC_OBJECT(a), b )
  208. #define stats_TimersDumpAll(a) __stats_TimersDumpAll( VLC_OBJECT(a) )
  209. VLC_EXPORT( void,__stats_TimerStart, (vlc_object_t*, const char *, unsigned int ) );
  210. VLC_EXPORT( void,__stats_TimerStop, (vlc_object_t*, unsigned int) );
  211. VLC_EXPORT( void,__stats_TimerDump, (vlc_object_t*, unsigned int) );
  212. VLC_EXPORT( void,__stats_TimersDumpAll, (vlc_object_t*) );
  213. #define stats_TimersCleanAll(a) __stats_TimersCleanAll( VLC_OBJECT(a) )
  214. VLC_EXPORT( void, __stats_TimersCleanAll, (vlc_object_t * ) );
  215.  
  216. #define stats_TimerClean(a,b) __stats_TimerClean( VLC_OBJECT(a), b )
  217. VLC_EXPORT( void, __stats_TimerClean, (vlc_object_t *, unsigned int ) );
  218.  
  219. #endif
  220.